Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(js): ♻️ Adding references to helia.io + Old js-ipfs stuff. #1694

Merged
merged 4 commits into from
Sep 22, 2023
Merged

feat(js): ♻️ Adding references to helia.io + Old js-ipfs stuff. #1694

merged 4 commits into from
Sep 22, 2023

Conversation

whizzzkid
Copy link
Contributor

Describe your changes

Adding reference to helia.io.

Files changed

  • docs/reference/js/api.md

What issue(s) does this address?

  • Restructure references to js ipfs implementations.

Does this update depend on any other PRs?

  • Not Applicable.

Checklist before requesting a review

  • Passing the beta version of the Check Markdown links for modified files check. Action results can be viewed here.

Checklist before merging

  • Passing all required checks (The beta Check Markdown links for modified files check is not required)

SgtPooki
SgtPooki requested changes Sep 14, 2023
View reviewed changes
docs/reference/js/api.md Outdated
Comment on lines 18 to 24

[JS-IPFS](https://github.com/ipfs/js-ipfs) was the first IPFS implementation in JavaScript. It still exists in its current form, but is no longer actively maintained. Please read [this post](https://github.com/ipfs/js-ipfs/issues/4336) to understand why this was done. For newer projects we recommend using [Helia](#helia) instead.

### Examples

JS-IPFS examples can be found [here](https://github.com/ipfs-examples/js-ipfs-examples).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we explicitly removed mentions of js-ipfs and don't want to re-add them

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. We shouldn't discuss js-ipfs.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed mentions in b9150b3

BigLep
BigLep reviewed Sep 14, 2023
View reviewed changes
docs/reference/js/api.md Outdated
Comment on lines 18 to 24

[JS-IPFS](https://github.com/ipfs/js-ipfs) was the first IPFS implementation in JavaScript. It still exists in its current form, but is no longer actively maintained. Please read [this post](https://github.com/ipfs/js-ipfs/issues/4336) to understand why this was done. For newer projects we recommend using [Helia](#helia) instead.

### Examples

JS-IPFS examples can be found [here](https://github.com/ipfs-examples/js-ipfs-examples).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. We shouldn't discuss js-ipfs.

docs/reference/js/api.md
@@ -5,10 +5,20 @@ description: Developer resources for working in JavaScript with IPFS, the InterP

# IPFS in JavaScript
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page should discuss the various ways one can "interface with IPFS" with JavaScript. Helia isn't the only way. At the minimum, we should add the js-kubo-rpc-client.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added mention in b9150b3

@ElPaisano
Copy link
Contributor

ElPaisano commented Sep 18, 2023 •
edited
Loading

Made an update that removes js-ipfs references, reorgs the page a bit, and adds js-kubo-rpc-client info. 3 callouts:

  1. The last update by a human to js-kubo-rpc-client was ipfs/js-kubo-rpc-client@8b24a94 in Feb. So this project is still maintained and applicable to Helia?
  2. helia.io is 404ing
  3. What other js tools should be added? Did a search of the ipfs repos and found things like js-unixfs, wasn't sure if that was too obscure to add

@ElPaisano ElPaisano self-requested a review September 18, 2023 20:53
ElPaisano
ElPaisano suggested changes Sep 18, 2023
View reviewed changes
docs/reference/js/api.md Show resolved Hide resolved
BigLep
BigLep reviewed Sep 20, 2023
View reviewed changes
docs/reference/js/api.md Outdated
Comment on lines 19 to 21

First, [install the client using `npm` or as a browser script tag](https://github.com/ipfs/js-kubo-rpc-client#install). Then, consult the [command reference](https://github.com/ipfs/js-kubo-rpc-client#usage) for usage information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also should mention that one needs to install Kubo. This can be done with https://www.npmjs.com/package/kubo

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.

ElPaisano
ElPaisano reviewed Sep 22, 2023
View reviewed changes
docs/reference/js/api.md Outdated Show resolved Hide resolved
@ElPaisano
Copy link
Contributor

Merging this in since it looks like the various comments were addressed. LMK if we need to reopen

@ElPaisano ElPaisano merged commit 701b92b into main Sep 22, 2023
4 of 6 checks passed
@ElPaisano ElPaisano deleted the feat/helia-js-ipfs branch September 22, 2023 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BigLep BigLep BigLep left review comments

@ElPaisano ElPaisano ElPaisano requested changes

@SgtPooki SgtPooki SgtPooki requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@whizzzkid @ElPaisano @BigLep @SgtPooki